home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 626-637 / disk_632 / printfiles / english / printfiles.doc.english < prev    next >
Text File  |  1992-05-06  |  20KB  |  559 lines
  1. *********************************************************************
  2. *                         PrintFiles                                *
  3. *                        Version 0.9e                               *
  4. *                                                                   *
  5. *               Copyright © 1992 by K.Klingbeil                     *
  6. *********************************************************************
  7.  
  8. Note: If you paid more than 5 $US/DM/£UK for a disk including PrintFiles
  9. your dealer is a thief and you're a fool!
  10.  
  11. *********************************************************************
  12. DISCLAIMER
  13. The author cannot be held liable for the  suitability or  accuracy
  14. of this manual  and/or  the  program(s)  it  describes.   Any  damage
  15. directly  or indirectly caused by the use or misuse of  this manual
  16. and/or the  program it describes is the sole responsibility of the
  17. user her/him self.
  18. *********************************************************************
  19.  
  20.  
  21. *********************************************************************
  22. DISTRIBUTION:
  23. PrintFiles, © Copyright 1992 K.Klingbeil. All rights reserved. This
  24. Program is FREEWARE so no financial donations are required ( but welcome ).
  25. This   program  may  be  freely  distributed  as  long  as all source code,
  26. documentation and executable remain unchanged and are included  with the
  27. distribution. Also no profit is to be made  by  selling  this  program.
  28.  
  29.  
  30. *********************************************************************
  31. *               Contents of this manual                             *
  32. *********************************************************************
  33.  
  34. 1. Introduction
  35. 2. Installation
  36.    2.1 Requirements
  37.    2.2 Installation
  38. 3. Quickstart
  39. 4. How to use PrintFiles
  40.    4.1. The printer icon
  41.    4.2. The control window
  42.         4.2.1 open the control window
  43.         4.2.2 close the control window
  44.         4.2.3 the settings of the control window
  45.    4.3. The prefs window
  46.         4.3.1 open the prefs window
  47.         4.3.2 close the prefs window
  48.         4.3.3 the settings of the prefs window
  49.  
  50. 5. The Arexx-Port
  51.    5.1. Command summary of the Arexx-Port
  52. 6. Starting Printfiles
  53.    6.1. Usage from CLI/Shell
  54.    6.2. Usage from Workbench
  55. 7. Notes
  56.  
  57. *********************************************************************
  58. *                      1. Introduction                              *
  59. *********************************************************************
  60.  
  61. PrintFiles is designed to replace the Printfiles-command distributed
  62. with your Workbench disk. Unlike the original printfiles it is more
  63. user-friendly and offers you much more possibilities , e.g. Headlines,
  64. date,time...
  65.  
  66. The features are:
  67.  
  68.     - Printer Icon on the Workbench.
  69.       To print a File simply drag its icon onto the printer icon.
  70.     - A print list of unlimited size.
  71.     - Files are also inserted into the print list by dragging their
  72.       icons into the control window.
  73.     - You can print headlines, baselines, date, time, filename,
  74.       page numbers and line numbers.
  75.     - You can set your printer to draft/lq quality.
  76.     - Arexx-Port with 23 commands gives you full control over Printfiles.
  77.     - Saves its preferences as Arexx-Scripts
  78.  
  79. Try it !
  80.  
  81. *********************************************************************
  82. *                    2. Installation                                *
  83. *********************************************************************
  84.  
  85. 2.1 Requirements
  86.     Printfiles runs only under OS 2.04 with system libraries V37+.
  87.     Printfiles uses only about 45K memory so that it will run even on
  88.     512K Amigas. Harddisk and/or additional memory are not required, but
  89.     useful.
  90.  
  91. 2.2 Installation
  92.     Printfiles needs no complex installation procedures. Just copy the
  93.     program into your c: or WBStartup directory.
  94.     If you want to use the Arexx-Port of Printfiles, be sure that the
  95.     RexxMaster Process is running before you attempt to run Printfiles.
  96.     Printfiles will not work if the Workbench is closed, so be sure that
  97.     you start PrintFiles after the LoadWB command.
  98.  
  99.     Note: if you run Printfiles multiple, an Arexx-Port exists only in
  100.     the first program.
  101.  
  102.     To start Printfiles automatically at Startup you can:
  103.        a. add the line 'PrintFiles' to the File s:user-startup
  104.        b. copy Printfiles into the WBStartup Drawer.
  105.           In this case you may add the ToolType DONOTWAIT to the
  106.           PrintFiles icon.
  107.  
  108. *********************************************************************
  109. *                     3. Quickstart                                 *
  110. *********************************************************************
  111.  
  112. This chapter gives you an example how to use Printfiles.
  113.  
  114.      Step 1 . Turn your printer on.
  115.      Step 2 . Doubleclick the Printfies icon or type
  116.               'PrintFiles'[return] into a shell window
  117.      Step 3 . Now you have an additional printer icon  on the
  118.               Workbench
  119.      Step 4 . Drag the icon of this .doc File on the Printer icon
  120.               and it will be printed.
  121.      Step 5 . Open the control window by double-clicking on the
  122.               printer icon.
  123.      Step 6 . Now You see the control window with the print list in
  124.               the center of the window
  125.      Step 7 . Drag more icons on the printer icon or into the control
  126.               window to insert them into the print list. you can also
  127.               insert files by typing the names into the StringGadget under
  128.               the list. To select files from a Filerequester click the
  129.               Request-Button.
  130.      Step 8 . Select some buttons, e.g. Date,Time ...
  131.      Step 9 . Click the Print-button and the whole list will be printed.
  132.      Step 10. After the print select the quit-button or the Close-Gadget
  133.               of the window. A requester will appear.
  134.      Step 11. Select the quit-button of the Requester.
  135.  
  136.  
  137. *********************************************************************
  138. *                     4. How to use Printfiles                      *
  139. *********************************************************************
  140.  
  141. The main Element in PrintFiles is the print list. The main operation
  142. in PrintFiles is to insert filenames into this list and print a  list.
  143. You can insert names in several ways: At Startup by the commandline or
  144. selected icons, by dragging icons onto the printer icon or into the
  145. control window, by using FileRequster or the Arexx-Port.
  146.  
  147. 4.1 The printer icon
  148.     PrintFiles adds a printer icon to the workbench. You can insert
  149.     files by dragging icons onto the printer icon.
  150.     If the control window is closed, this files are immediately printed.
  151.     If the window is open, they are added at the end of the list.
  152.  
  153. 4.2 The control window
  154.     This window contains all settings for the printer. It can be opened
  155.     or closed as you like and it remembers its position on re-opening.
  156.     NOTE: If you use a NTSC-machine check chapter 2.1 !
  157.  
  158.     4.2.1 Opening the control window
  159.           The window is normally closed at startup. You can open it
  160.           a. at startup  (see also chapter 6)
  161.              - from CLI/Shell by using option -w.
  162.              - from Workbench by using the TOOL TYPE
  163.                WINDOW=<left edge><top edge>.
  164.  
  165.           b. at runtime
  166.              - by double-clicking on the printer icon.
  167.              - by selecting the Item 'Printfiles' in the
  168.                Workbench-Tool-Menu.
  169.              - by sending the command 'openwindow <left edge><top edge>'
  170.                to the Arexx-Port of Printfiles. (see also chapter 5)
  171.  
  172.     4.2.2 Closing the control window
  173.           - Double-click on the printer icon
  174.           - Select the Item 'Printfiles' in the Workbench-Tool-Menu.
  175.           - Send the command 'closewindow' to the Arexx-Port of Printfiles.
  176.             (see also chapter 5)
  177.  
  178. *********************************************************************
  179. *                          5. Settings                              *
  180. *********************************************************************
  181.  
  182. The setting of the control window are ( top down ):
  183.  
  184.       -Prefs
  185.         AREXX    : openwindow prefs <LeftEdge><TopEdge>
  186.         opens the printer preferences window at <leftedge><topedge>
  187.  
  188.       -about
  189.         AREXX    : version
  190.         Displays a requester containing the version number
  191.  
  192.       -Button date/Time/File
  193.         AREXX    : date on/off
  194.                    time on/off
  195.                    file on/off
  196.         CLI      : -d -t -n
  197.         TOOL TYPE: FLAGS=d FLAGS=t FLAGS=n
  198.         If one of these buttons is checked,  additional headline with
  199.         the requested information is generated.
  200.  
  201.        -Stringgadget headline/footline
  202.         AREXX    : headline  [...] sets headline  string
  203.                    footline [...] sets footline string
  204.         TOOL TYPE: headline=[...] footline=[...]
  205.         If a string is set, it will be printed on the top/foot of each
  206.         page.
  207.  
  208.        -Pagenumbers
  209.         AREXX    : page on/off
  210.         CLI      : -p
  211.         TOOL TYPE: FLAG=p
  212.         If checked, the string *** Page: xxxxx *** will be printed
  213.         on the foot of each page. Additionally, at the end of a file
  214.         the count of pages of this file is printed.
  215.  
  216.        -LineNumbers
  217.         AREXX    : line on/off
  218.         CLI      : -l
  219.         TOOL TYPE: FLAGS=l
  220.         If checked, each line will have a number.
  221.  
  222.        -CR/LF
  223.         AREXX    : crlf
  224.         CLI      : -c
  225.         TOOL TYPE: FALGS=c
  226.         If checked, an additional linefeed is printed after each line.
  227.  
  228.        -Form Feed
  229.         AREXX    : ff on/off
  230.         CLI      : -f
  231.         TOOL TYPE: FLAGS=f
  232.         If checked, a Form Feed is printed after each file.
  233.  
  234.        -Request
  235.         Displays a FileRequester and adds the choosen file to
  236.         the list.
  237.  
  238.        -Remove
  239.         AREXX    : remfile  remfile <File>
  240.         If you click onto a filename in the list, this file will be
  241.         displayed in the stringgadget beneath the remove-button.
  242.         If you then click this button, the file is removed from the
  243.         list. If the stringgadgets contains no name, the last file
  244.         of the list is removed.
  245.  
  246.        -Print
  247.         AREXX    : print
  248.         Begins printing the list. While Printing, this gadget is disabled.
  249.         You can perform all other functions like adding files, removing
  250.         files and so on. All changes are immediately recognized.
  251.         NOTE: It depends on the size of the printer buffer how fast the
  252.               changes will appear on the paper !
  253.  
  254.        -Quit  (and CloseGadget of the window)
  255.         AREXX    : quit
  256.         If the program is currently printing it will request you to abort
  257.         or continue the print.
  258.         If the program is not printing it will request you to quit the
  259.         program or to close the window (see chapter 4.2.1 and 4.2.2)
  260.         NOTE: the Arexx command will not display a requester !
  261.  
  262. 4.3. The Prefs Window
  263.  
  264.   4.3.2 Opening the prefs window
  265.         - click the 'Prefs' button in the control window
  266.         - send the 'openwindow prefs <Leftedge><TopEdge>' command to
  267.           the Arexx-Port.
  268.   4.3.3 Closing the prefs window
  269.         - click the closegadget of the prefs window
  270.         - send the 'closewindow prefs' command to
  271.           the Arexx-Port.
  272.   4.3.3 Settings of the prefs Window
  273.  
  274.         -button Draft/Lq
  275.          AREXX     : draft
  276.                      lq
  277.          TOOL TYPE : FLAGS=a
  278.                      FLAGS=q
  279.          CLI       : -a -q
  280.          Set the print quality to draft or lq
  281.  
  282.         -button 6 lines/inch  8 lines/inch.
  283.          AREXX     : 6li
  284.                      6li
  285.          TOOL TYPE : FLAGS=6
  286.                      FLAGS=8
  287.          CLI       : -6 -8
  288.          Set the spacing to 1/6 inch or 1/8 inch.
  289.  
  290.         -button 10cpi/12cpi/15cpi
  291.          AREXX     : 10cpi
  292.                      12cpi
  293.                      15cpi
  294.          TOOL TYPE : FLAGS=0
  295.                      FLAGS=2
  296.                      FLAGS=5
  297.          CLI       : -0 -2 -5
  298.          Set the pitch to Normal (10cpi) / Elite (12cpi) / condensed (15cpi).
  299.  
  300.         -stringgadget Lines/page
  301.          AREXX     : lines <number>
  302.          TOOL TYPE : LINES=<number>
  303.          Print <number> lines on each page.
  304.  
  305.         -stringgadget Left Margin
  306.          AREXX     : lmargin <number>
  307.          TOOL TYPE : LMARGIN=<number>
  308.          Set the left margin to column <number>
  309.  
  310.         -stringgadget Right Margin
  311.          AREXX     : rmargin <number>
  312.          TOOL TYPE : RMARGIN=<number>
  313.          Set the right margin to column <number>
  314.  
  315.         -button Print
  316.          same as Print-button in the control window.
  317.  
  318.         -button Save
  319.          AREXX     : saveprefs <filename>
  320.          Saves the current setting (including print list) as an Arexx-Script.
  321.          If no filename is given you will be prompted by a requester.
  322.  
  323. *********************************************************************
  324. *                      5. The Arexx-Port                            *
  325. *********************************************************************
  326.  
  327. The Arexx-port of Printfiles is named 'PRINTFILES'
  328.  
  329. 5.1. Command summary
  330.  
  331.     - clear
  332.       Returns     : nothing
  333.       Arguments   : none
  334.       Clears the print list.
  335.  
  336.     - closewindow <which>
  337.       Returns     : nothing
  338.       Arguments   : control      // close control window
  339.                     prefs        // close prefs window
  340.       Closes the specified  window. If the window is currently closed, the
  341.       command is ignored.
  342.  
  343.     - crlf <on><off>
  344.       Returns     : nothing
  345.       Arguments   : on or off
  346.       sets/clears the button CR/LF
  347.  
  348.     - date <on><off>
  349.       Returns     : nothing
  350.       Arguments   : on or off
  351.       sets/clears the date-button
  352.  
  353.     - draft
  354.       Returns     : nothing
  355.       Arguments   : none
  356.       Sets the printer to draft mode.
  357.  
  358.     - file <on><off>
  359.       Returns     : nothing
  360.       Arguments   : on or off
  361.       sets/clears the filename-button.
  362.  
  363.     - ff <on><off>
  364.       Returns: none
  365.       Arguments   : on or off
  366.       sets/clears the FormFeed-button.
  367.  
  368.     - insfile <filename>
  369.       Returns     : nothing
  370.       Arguments   : filename
  371.       Adds the <filename> to the print list
  372.  
  373.     - line <on><off>
  374.       Returns     : nothing
  375.       Arguments   : on or off
  376.       sets/clears the LineNumber-button.
  377.  
  378.     - lines <zahl>
  379.       Returns     : nothing
  380.       Arguments   : number
  381.       <number> lines per page will be printed.
  382.  
  383.     - lmargin <number>
  384.       Returns     : nothing
  385.       Arguments   : number
  386.       Sets the left  margin to column #<number>
  387.  
  388.     - lq
  389.       Returns     : nothing
  390.       Arguments   : none
  391.       Sets the printer to NLQ mode.
  392.  
  393.     - openwindow <which> <left edge> <top edge>
  394.       Returns     : nothing
  395.       Arguments   : <which> control  //open the control window
  396.                             prefs    //open the prefs window
  397.                     <left>  number
  398.                     <right> number
  399.       Opens the specified  window at <left edge> <top edge>.
  400.       If the edges doesn't fit on the screen the window
  401.       will be adjusted, e.g. 'openwindow control 10000 10000' will
  402.       place the window in the right bottom edge of the screen.
  403.       If no numbers are given, the window will be opened on
  404.       the position where it was closed.
  405.       if the window is already open, the command is ignored.
  406.  
  407.     - page <on><off>
  408.       Returns     : nothing
  409.       Arguments   : on or off
  410.       sets/clears the Pagenumber-button.
  411.  
  412.     - print
  413.       Returns     : nothing
  414.       Arguments   : none
  415.       Starts printing the list.
  416.  
  417.     - remfile <filename>
  418.       Returns: "NOT-IN-LIST"     if the filename isn't in the list
  419.                "LIST_EMPTY"      if the list was empty
  420.                ""                o.k.
  421.       Arguments   : filename
  422.       Removes the file <filename> from the list.
  423.       if no filename is given the last file of the list is removed.
  424.  
  425.     - reset
  426.       Returns     : nothing
  427.       Arguments   : none
  428.       Clears all buttons, clears the list and sets the printer to
  429.       draft mode.
  430.  
  431.     - rmargin <number>
  432.       Returns     : nothing
  433.       Arguments   : number
  434.       Sets the right margin to column #<number>
  435.  
  436.     - status
  437.       Returns     : "PRINTING" if Printfiles is currently printing
  438.                     "WAITING"  if PrintFiles isn't printing
  439.       Arguments   : none
  440.  
  441.     - time <on><off>
  442.       Returns: none
  443.       Arguments   : on or off
  444.       sets/clears the time-button.
  445.  
  446.     - headline <string>
  447.       Returns     : nothing
  448.       Arguments   : string
  449.       Sets the footline string.
  450.  
  451.     - quit
  452.       Returns     : nothing
  453.       Arguments   : none
  454.       if PrintFiles is currently printing, the print will be aborted.
  455.       if PrintFiles isn't printing, the program will be quit.
  456.       NOTE: No requesters are displayed !
  457.  
  458.     - version
  459.       Returns     : Version string  (e.g. "Version 0.9e")
  460.       Arguments   : none
  461.  
  462.  
  463.  
  464. *********************************************************************
  465. *                   6. Starting PrintFiles                          *
  466. *********************************************************************
  467.  
  468. 6.1. Usage from Shell/CLI
  469.      printfiles -<flags> file file  ....
  470.      There is no need to 'run' Printfiles.
  471.  
  472.      The following flags are supported:
  473.  
  474.      -t sets the time-button
  475.      -f sets the formfeed-button
  476.      -n sets the filename-button
  477.      -d sets the date-button
  478.      -p sets the pagenumber-button
  479.      -l sets the linenumber-button
  480.      -c sets the CR/LF-button
  481.      -a sets the draft-button (Default)
  482.      -q sets the NLQ-button
  483.      -w open the control window at startup
  484.      -0\
  485.      -2 > set the print pitch to 10cpi/12cpi/15cpi
  486.      -5/
  487.      -6\
  488.      -8/  set the spacing to 1/6 inch or 1/8 inch
  489.  
  490.      The flags can be given as single (e.g. printfiles -w -p -f)
  491.      or grouped (e.g. printfiles -wpf)
  492.  
  493.      All names without hyphen are treated as filenames and are
  494.      added to the print list. If you have specified filenames on
  495.      the command line, they will be printed immediately after
  496.      startup.
  497.  
  498. 6.2. Usage from Workbench
  499.      TOOL TYPES are:
  500.  
  501.      FLAGS= see chapter 6.1.
  502.             Unlike to the CLI you should have only one FLAGS-field.
  503.             (only the first is evaluated !)
  504.  
  505.      WINDOW=<left edge> <top edge>
  506.             Opens the control window (see also chapter 5.1 - openwindow)
  507.  
  508.      LINES=<number>
  509.             <number>lines will be print on each page
  510.             (see chapter 5.1. - lines)
  511.  
  512.      HEADLINE=<string>
  513.             The headline string is set to <string>
  514.             (see chapter 5.1. - headline)
  515.  
  516.      FOOTLINE=<string>
  517.             The footline string is set to <string>
  518.             (see chapter 5.1. - footline)
  519.  
  520.      RMARGIN=<number>
  521.             Sets the right margin to column #<number>
  522.             (see chapter 5.1. - rmargin)
  523.  
  524.      LMARGIN=<number>
  525.             Sets the left margin to column #<number>
  526.             (see chapter 5.1. - lmargin)
  527.  
  528.      You can add files to the list by extended selection with the
  529.      program icon and file icons.
  530.      All selected files are added to the print list and will be
  531.      printed immediately after startup.
  532.  
  533.  
  534. *********************************************************************
  535. *                         7. Notes                                  *
  536. *********************************************************************
  537.  
  538. PrintFiles is Copyright ©1992 K.Klingbeil, All Rights Reserved. There
  539. are 2 Versions, 0.9d in german and 0.9e in english.
  540. Printfiles was programmed with SAS/C 5.10b on an A2000 with 3MB Memory,
  541. A2091 SCSI-Controller and Quantum LPS40 under OS 2.04 (Kick 37.175).
  542.  
  543. Bug reports,  suggestions, criticism, money, jewellery and other gifts
  544. to
  545.  
  546.  
  547.                          Karlheinz Klingbeil
  548.                          Elzstr. 42
  549.  
  550.                          W-7809 Gutach
  551.                          Federal Republic of Germany
  552.  
  553.  
  554. And now: Have Fun !!!
  555.  
  556. *********************************************************************
  557.  
  558.  
  559.